feat: add markdown export support for issues#15
Merged
Conversation
- Add formatIssueAsMarkdown() function to lib/utils.js - Add --format and --output options to issue view command - Support viewing issues as markdown in terminal with --format markdown - Support exporting issues to markdown files with --output <path> - Update README with markdown export examples and features - Update roadmap to reflect completed markdown support
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds markdown export functionality to the JIRA CLI, enabling users to view issues in markdown format and export them to files. This completes the markdown read/write workflow alongside the existing --description-file feature.
Key Changes:
- Added
formatIssueAsMarkdown()function to convert issue data to markdown format - Extended
jira issue viewcommand with--format markdownand--output <path>options - Updated documentation to reflect new markdown capabilities
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| lib/utils.js | Implements formatIssueAsMarkdown() function and exports it for use in commands |
| README.md | Updates feature list, usage examples, command reference table, and roadmap to document markdown export support |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Replace string concatenation with template literals for better readability
github-actions bot
pushed a commit
that referenced
this pull request
Dec 11, 2025
# [2.2.0](v2.1.2...v2.2.0) (2025-12-11) ### Features * add markdown export support for issues ([#15](#15)) ([9691ea5](9691ea5))
|
🎉 This PR is included in version 2.2.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
jira issue viewcommandChanges
New Features
formatIssueAsMarkdown()function inlib/utils.jsto convert issues to markdown format--format <terminal|markdown>option tojira issue viewcommand--output <path>option to save issues to markdown filesDocumentation
Usage Examples
View issue as markdown in terminal:
Export issue to markdown file:
Markdown format includes:
Testing
Related Features
This complements the existing
--description-filefeature for creating/updating issues from markdown files, completing the markdown read/write workflow.